home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Resources / Browsers, Managers & Extensions / Mozilla Weave 0.2.7 / latest-weave.xpi / modules / trackers.js < prev    next >
Text File  |  2008-07-08  |  3KB  |  95 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is Bookmarks Sync.
  15.  *
  16.  * The Initial Developer of the Original Code is Mozilla.
  17.  * Portions created by the Initial Developer are Copyright (C) 2008
  18.  * the Initial Developer. All Rights Reserved.
  19.  *
  20.  * Contributor(s):
  21.  *  Anant Narayanan <anant@kix.in>
  22.  *
  23.  * Alternatively, the contents of this file may be used under the terms of
  24.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26.  * in which case the provisions of the GPL or the LGPL are applicable instead
  27.  * of those above. If you wish to allow use of your version of this file only
  28.  * under the terms of either the GPL or the LGPL, and not to allow others to
  29.  * use your version of this file under the terms of the MPL, indicate your
  30.  * decision by deleting the provisions above and replace them with the notice
  31.  * and other provisions required by the GPL or the LGPL. If you do not delete
  32.  * the provisions above, a recipient may use your version of this file under
  33.  * the terms of any one of the MPL, the GPL or the LGPL.
  34.  *
  35.  * ***** END LICENSE BLOCK ***** */
  36.  
  37. const EXPORTED_SYMBOLS = ['Tracker'];
  38.  
  39. const Cc = Components.classes;
  40. const Ci = Components.interfaces;
  41. const Cr = Components.results;
  42. const Cu = Components.utils;
  43.  
  44. Cu.import("resource://gre/modules/XPCOMUtils.jsm");
  45. Cu.import("resource://weave/log4moz.js");
  46. Cu.import("resource://weave/constants.js");
  47. Cu.import("resource://weave/util.js");
  48. Cu.import("resource://weave/async.js");
  49.  
  50. Function.prototype.async = Async.sugar;
  51.  
  52. /*
  53.  * Trackers are associated with a single engine and deal with
  54.  * listening for changes to their particular data type
  55.  * and updating their 'score', indicating how urgently they
  56.  * want to sync.
  57.  *
  58.  * 'score's range from 0 (Nothing's changed)
  59.  * to 100 (I need to sync now!)
  60.  * -1 is also a valid score
  61.  * (don't sync me unless the user specifically requests it)
  62.  *
  63.  * Setting a score outside of this range will raise an exception.
  64.  * Well not yet, but it will :)
  65.  */
  66. function Tracker() {
  67.   this._init();
  68. }
  69. Tracker.prototype = {
  70.   _logName: "Tracker",
  71.   _score: 0,
  72.  
  73.   _init: function T__init() {
  74.     this._log = Log4Moz.Service.getLogger("Service." + this._logName);
  75.     this._score = 0;
  76.   },
  77.  
  78.   /* Should be called by service periodically
  79.    * before deciding which engines to sync
  80.    */
  81.   get score() {
  82.     if (this._score >= 100)
  83.       return 100;
  84.     else
  85.       return this._score;
  86.   },
  87.  
  88.   /* Should be called by service everytime a sync
  89.    * has been done for an engine
  90.    */
  91.   resetScore: function T_resetScore() {
  92.     this._score = 0;
  93.   }
  94. };
  95.